.. _CScreenMap Class: ========================== CScreenMap Class ========================== .. toctree:: :maxdepth: 1 * :ref:`Overview` * :ref:`Quick Reference` * :ref:`Constructors` * :ref:`Methods` ---- .. _CScreenMap_Overview: Overview --------------- .. note:: The **CScreenMap** class handles the local area map and map note management The structure used for this class is :ref:`CScreenMap` ---- .. _CScreenMap_QuickRef: Quick Reference --------------- +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Quick Ref** | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:CScreenMap**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:CancelEngine**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:CenterViewPort**\(:ref:`CPoint`\& ptPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckMouseLButton**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckMouseMove**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckMouseRButton**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckMouseWheel**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckSystemKeyCapsLock**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckSystemKeyCtrl**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:CheckSystemKeyShift**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bool **CScreenMap\:\:DisplayExploredMap**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:EngineActivated**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:EngineDeactivated**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:EngineDestroyed**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:EngineGameInit**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:EngineGameUninit**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:EngineInitialized**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:GetCapsLockKey**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenMap\:\:GetColorChoice**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:GetCtrlKey**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual short **CScreenMap\:\:GetNumVirtualKeys**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMap\:\:GetShiftKey**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual :ref:`CKeyInfo`\* **CScreenMap\:\:GetVirtualKeys**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int\* **CScreenMap\:\:GetVirtualKeysFlags**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenMap\:\:IsNoteVisible**\(int x, int y) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:OnColorChoice**\(int sequence) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual bool **CScreenMap\:\:OnEvent**\(SDL_Event\* e) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnKeyDown**\(int nKeysFlags) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnKeyUp**\(int nKeysFlags) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnLButtonDblClk**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnLButtonDown**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnLButtonUp**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:OnMapAddNote**\(int x, int y) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnMouseMove**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnMouseWheel**\(int bForward, long nTicks, unsigned long nLines, unsigned short wFlags) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnPortraitLClick**\(unsigned long id) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnPortraitLDblClick**\(unsigned long id) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnRButtonDown**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnRButtonUp**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:OnRestButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:OnUserNoteClick**\(int id, int x, int y) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:OnUserNoteDeleteButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:OnUserNoteDoneButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenMap\:\:RenderAreaMap**\(:ref:`CRect` r) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:RenderCharacters**\(:ref:`CRect`\& rClip) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned char **CScreenMap\:\:RenderFogOfWar**\(:ref:`CVidMode`\* pVidMode, :ref:`CRect`\& r) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:RenderViewRect**\(:ref:`CVidMode`\* pVidMode, :ref:`CPoint`\& ptStart, :ref:`CRect`\& rClipBase, :ref:`CRect`\& rWorldView) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:SetMap**\(:ref:`CGameArea`\* pArea) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:SetSystemKeyCapsLock**\(int bValue) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:SetSystemKeyCtrl**\(unsigned char bValue) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:SetSystemKeyShift**\(int bValue) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:TimerAsynchronousUpdate**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMap\:\:TimerSynchronousUpdate**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:ToggleDisplayExploredMap**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMap\:\:UpdateMainPanel**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CPoint` **CScreenMap\:\:WorldToMap**\(:ref:`CPoint` pt) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- .. _CScreenMap_Constructors: Constructors --------------- +---------------------------------------------------------------+------------------------------------------------------+ | **Name** | **Description** | +---------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenMap\:\:CScreenMap` | Constructs a ``CScreenMap`` object | +---------------------------------------------------------------+------------------------------------------------------+ .. _CScreenMapCScreenMap: CScreenMap\:\:CScreenMap ^^^^^^^^^^^^^^^^^^^^^^^^^ Constructs a ``CScreenMap`` object :: void CScreenMap::CScreenMap(); **Remarks** Constructs a ``CScreenMap`` object ---- .. _CScreenMap_Methods: Methods --------------- +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | **Name** | **Description** | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CancelEngine` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CenterViewPort` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckMouseLButton` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckMouseMove` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckMouseRButton` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckMouseWheel` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckSystemKeyCapsLock` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckSystemKeyCtrl` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:CheckSystemKeyShift` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:DisplayExploredMap` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:EngineActivated` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:EngineDeactivated` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:EngineDestroyed` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:EngineGameInit` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:EngineGameUninit` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:EngineInitialized` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetCapsLockKey` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetColorChoice` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetCtrlKey` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetNumVirtualKeys` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetShiftKey` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetVirtualKeys` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:GetVirtualKeysFlags` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:IsNoteVisible` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnColorChoice` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnEvent` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnKeyDown` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnKeyUp` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnLButtonDblClk` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnLButtonDown` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnLButtonUp` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnMapAddNote` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnMouseMove` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnMouseWheel` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnPortraitLClick` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnPortraitLDblClick` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnRButtonDown` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnRButtonUp` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnRestButtonClick` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnUserNoteClick` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnUserNoteDeleteButtonClick` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:OnUserNoteDoneButtonClick` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:RenderAreaMap` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:RenderCharacters` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:RenderFogOfWar` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:RenderViewRect` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:SetMap` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:SetSystemKeyCapsLock` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:SetSystemKeyCtrl` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:SetSystemKeyShift` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:TimerAsynchronousUpdate` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:TimerSynchronousUpdate` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:ToggleDisplayExploredMap` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:UpdateMainPanel` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMap\:\:WorldToMap` | | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ---- .. _CScreenMapCancelEngine: CScreenMap\:\:CancelEngine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCenterViewPort: CScreenMap\:\:CenterViewPort ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckMouseLButton: CScreenMap\:\:CheckMouseLButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckMouseMove: CScreenMap\:\:CheckMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckMouseRButton: CScreenMap\:\:CheckMouseRButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckMouseWheel: CScreenMap\:\:CheckMouseWheel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckSystemKeyCapsLock: CScreenMap\:\:CheckSystemKeyCapsLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckSystemKeyCtrl: CScreenMap\:\:CheckSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapCheckSystemKeyShift: CScreenMap\:\:CheckSystemKeyShift ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapDisplayExploredMap: CScreenMap\:\:DisplayExploredMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapEngineActivated: CScreenMap\:\:EngineActivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapEngineDeactivated: CScreenMap\:\:EngineDeactivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapEngineDestroyed: CScreenMap\:\:EngineDestroyed ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapEngineGameInit: CScreenMap\:\:EngineGameInit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapEngineGameUninit: CScreenMap\:\:EngineGameUninit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapEngineInitialized: CScreenMap\:\:EngineInitialized ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetCapsLockKey: CScreenMap\:\:GetCapsLockKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetColorChoice: CScreenMap\:\:GetColorChoice ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetCtrlKey: CScreenMap\:\:GetCtrlKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetNumVirtualKeys: CScreenMap\:\:GetNumVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetShiftKey: CScreenMap\:\:GetShiftKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetVirtualKeys: CScreenMap\:\:GetVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapGetVirtualKeysFlags: CScreenMap\:\:GetVirtualKeysFlags ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapIsNoteVisible: CScreenMap\:\:IsNoteVisible ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnColorChoice: CScreenMap\:\:OnColorChoice ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnEvent: CScreenMap\:\:OnEvent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnKeyDown: CScreenMap\:\:OnKeyDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnKeyUp: CScreenMap\:\:OnKeyUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnLButtonDblClk: CScreenMap\:\:OnLButtonDblClk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnLButtonDown: CScreenMap\:\:OnLButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnLButtonUp: CScreenMap\:\:OnLButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnMapAddNote: CScreenMap\:\:OnMapAddNote ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnMouseMove: CScreenMap\:\:OnMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnMouseWheel: CScreenMap\:\:OnMouseWheel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnPortraitLClick: CScreenMap\:\:OnPortraitLClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnPortraitLDblClick: CScreenMap\:\:OnPortraitLDblClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnRButtonDown: CScreenMap\:\:OnRButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnRButtonUp: CScreenMap\:\:OnRButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnRestButtonClick: CScreenMap\:\:OnRestButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnUserNoteClick: CScreenMap\:\:OnUserNoteClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnUserNoteDeleteButtonClick: CScreenMap\:\:OnUserNoteDeleteButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapOnUserNoteDoneButtonClick: CScreenMap\:\:OnUserNoteDoneButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapRenderAreaMap: CScreenMap\:\:RenderAreaMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapRenderCharacters: CScreenMap\:\:RenderCharacters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapRenderFogOfWar: CScreenMap\:\:RenderFogOfWar ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapRenderViewRect: CScreenMap\:\:RenderViewRect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapSetMap: CScreenMap\:\:SetMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapSetSystemKeyCapsLock: CScreenMap\:\:SetSystemKeyCapsLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapSetSystemKeyCtrl: CScreenMap\:\:SetSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapSetSystemKeyShift: CScreenMap\:\:SetSystemKeyShift ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapTimerAsynchronousUpdate: CScreenMap\:\:TimerAsynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapTimerSynchronousUpdate: CScreenMap\:\:TimerSynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapToggleDisplayExploredMap: CScreenMap\:\:ToggleDisplayExploredMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapUpdateMainPanel: CScreenMap\:\:UpdateMainPanel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMapWorldToMap: CScreenMap\:\:WorldToMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks**